Skip to main content

Asynchronous product publication API

The product GraphQL API now supports the triggering of asynchronous product publications.

New GraphQL mutation:

triggerProductPublicationProcess - Initiates the product publication process for one or multiple products and returns the productPublicationProcesses object, which includes the status, trigger date, and errors if the process fails.

Query to track the publication process of a product:

productPublicationProcess - Allows users to track the publication process of a product by process ID. It provides data including the status, the trigger date, the start date (as it is an async queued process), and any errors encountered.

Limitations

  • Currently, there is no UI to monitor the progress of products queued for publication.
  • Users must call the Marketplace Product Settings API to add a product to a marketplace or can add them manually from the staging catalog.
  • When republishing (publishing changes to a previously published product), the users can configure a product (optional) under the previous Product Marketplace settings. They can also modify the values through an API post publication.

Information about Understanding Product publication is available on the developer portal.

A guide to use this and other Product APIs for an end to end flow can be can be found on the developer portal guides section:

Product | AppDirect | Developer Portal

note

The API is in Early Access (EA). To enroll in the EA program, contact Support or your AppDirect representative.

Feature enablement

The feature is not enabled by default. Contact your AppDirect technical representative to request it.

Setting enablement

No setting enablement is required.

Documentation

Documentation changes are updated.

Was this page helpful?